<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \UserGroupsController</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Cake.html"><i class="icon-folder-open"></i> Cake</a></li>
<li><a href="../packages/Controller.html"><i class="icon-folder-open"></i> Controller</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Model.html"><i class="icon-folder-open"></i> Model</a></li>
<li><a href="../packages/View.html"><i class="icon-folder-open"></i> View</a></li>
<li><a href="../packages/app.html"><i class="icon-folder-open"></i> app</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">64</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">20</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method_add" title="add :: add method."><span class="description">add method.</span><pre>add()</pre></a></li>
<li class="method public inherited"><a href="#method_beforeFilter" title="beforeFilter :: "><span class="description">beforeFilter()
        </span><pre>beforeFilter()</pre></a></li>
<li class="method public "><a href="#method_delete" title="delete :: delete method."><span class="description">delete method.</span><pre>delete()</pre></a></li>
<li class="method public "><a href="#method_edit" title="edit :: edit method."><span class="description">edit method.</span><pre>edit()</pre></a></li>
<li class="method public "><a href="#method_index" title="index :: index method."><span class="description">index method.</span><pre>index()</pre></a></li>
<li class="method public inherited"><a href="#method_uploadFiles" title="uploadFiles :: Utility function to handle file uploads."><span class="description">Utility function to handle file uploads.</span><pre>uploadFiles()</pre></a></li>
<li class="method public "><a href="#method_view" title="view :: view method."><span class="description">view method.</span><pre>view()</pre></a></li>
</ul>
</li>
<li class="nav-header protected">» Protected
                    <ul><li class="method protected inherited"><a href="#method_flatten_attributes" title="flatten_attributes :: Utility method for providing flat access to persisted attributes"><span class="description">Utility method for providing flat access to persisted attributes</span><pre>flatten_attributes()</pre></a></li></ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties
                    <ul>
<li class="property public "><a href="#property_UserGroup" title="$UserGroup :: "><span class="description"></span><pre>$UserGroup</pre></a></li>
<li class="property public inherited"><a href="#property_components" title="$components :: "><span class="description"></span><pre>$components</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\UserGroupsController"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/UserGroupsController.html">UserGroupsController</a>
</li>
</ul>
<div class="element class">
<p class="short_description">UserGroups Controller</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/Default.html">Controller</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method_add"></a><div class="element clickable method public method_add" data-toggle="collapse" data-target=".method_add .collapse">
<h2>add method.</h2>
<pre>add() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"><p>Adds a user group to the system when a post request is made.
Otherwise displays page to enter user group information</p></div></div></div>
</div>
<a id="method_beforeFilter"></a><div class="element clickable method public method_beforeFilter" data-toggle="collapse" data-target=".method_beforeFilter .collapse">
<h2>beforeFilter()
        </h2>
<pre>beforeFilter() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\AppController::beforeFilter()</td>
</tr></table>
</div></div>
</div>
<a id="method_delete"></a><div class="element clickable method public method_delete" data-toggle="collapse" data-target=".method_delete .collapse">
<h2>delete method.</h2>
<pre>delete(int $id) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Removes a user from a group.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id</h4>
<code>int</code><p>The id of the user group to delete</p></div>
</div></div>
</div>
<a id="method_edit"></a><div class="element clickable method public method_edit" data-toggle="collapse" data-target=".method_edit .collapse">
<h2>edit method.</h2>
<pre>edit(integer $id) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Edits a user group.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id</h4>
<code>integer</code><p>The id of the user group to edit.</p></div>
</div></div>
</div>
<a id="method_index"></a><div class="element clickable method public method_index" data-toggle="collapse" data-target=".method_index .collapse">
<h2>index method.</h2>
<pre>index() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"><p>Lists user groups</p></div></div></div>
</div>
<a id="method_uploadFiles"></a><div class="element clickable method public method_uploadFiles" data-toggle="collapse" data-target=".method_uploadFiles .collapse">
<h2>Utility function to handle file uploads.</h2>
<pre>uploadFiles(string $folder, \unknown_type $formdata, string $itemId) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\AppController::uploadFiles()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$folder</h4>
<code>string</code><p>The path to save the file</p></div>
<div class="subelement argument">
<h4>$formdata</h4>
<code>\unknown_type</code><p>The form data to use</p></div>
<div class="subelement argument">
<h4>$itemId</h4>
<code>string</code><p>An optional id for teh item</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The result of the operation</div>
</div></div>
</div>
<a id="method_view"></a><div class="element clickable method public method_view" data-toggle="collapse" data-target=".method_view .collapse">
<h2>view method.</h2>
<pre>view(int $id) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Views the user group with the given id</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$id</h4>
<code>int</code><p>The id of the group to view</p></div>
</div></div>
</div>
<a id="method_flatten_attributes"></a><div class="element clickable method protected method_flatten_attributes" data-toggle="collapse" data-target=".method_flatten_attributes .collapse">
<h2>Utility method for providing flat access to persisted attributes</h2>
<pre>flatten_attributes(array $attributes) : \flat</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\AppController::flatten_attributes()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><p>of SQL results</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>\flat</code>array of name/value pairs</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_UserGroup"> </a><div class="element clickable property public property_UserGroup" data-toggle="collapse" data-target=".property_UserGroup .collapse">
<h2></h2>
<pre>$UserGroup : <a href="../classes/UserGroup.html">\UserGroup</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>magic</th>
<td></td>
</tr>
<tr>
<th>property</th>
<td></td>
</tr>
</table>
</div></div>
</div>
<a id="property_components"> </a><div class="element clickable property public property_components" data-toggle="collapse" data-target=".property_components .collapse">
<h2></h2>
<pre>$components </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\AppController::$$components</td>
</tr></table>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
            generated on 2012-12-14T12:15:28+11:00.<br></footer></div>
</div>
</body>
</html>
